Gateways API

POST /gateways

Description

This API endpoint retrieves a list of all available gateways in the system.

Request Body

The request utilizes GraphQL to perform the gateways query.

Query:

query gateways {
    gateways {
        id
        name
    }
}

Variables:

{}

Example Request:

curl --location '' \
--header 'Content-Type: application/json' \
--data '{"query":"query gateways {\n    gateways {\n        id\n        name\n    }\n}","variables":{}}'

Response:

• Success (200 OK):

  • The response contains a list of all available gateways.

  {
    "data": {
      "gateways": [
        {
          "id": "<Gateway_ID>",
          "name": "<Gateway_Name>"
        },
        ...
      ]
    }
  }

• Error (4XX/5XX):

  • If there is an issue with retrieving the gateways, such as authentication errors or server errors, the response will include an appropriate error message and status code.

Note:

Ensure the request is authenticated if required to retrieve the correct list of gateways.